/*
 * Copyright (c) 2008 Openviewing
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Created: 10-Sep-2006
 */
package org.openviewing.foundation.control.command.impl;

import org.openviewing.foundation.control.DomainCommandStrategy;
import org.openviewing.foundation.model.Model;

/** Basic template for a command.
 *
 * This class implements the template design pattern<sup>[GOF]</sup>.
 * <br />References
 * <ul>
 *   <li><strong>[GOF]</strong> Gamma, Erich. Helm, Richard. Johnson, Ralph. Vlissides, Johhn. <i>Design Patterns, Elements of reusable Object-Oriented Software</i> Addison-Wesley, 1995.</li>
 * </ul>
 */
public abstract class CommandTemplate implements DomainCommandStrategy
{
    // Private Attributes //////////////////////////////////////////////////////

    // Protected Attributes ////////////////////////////////////////////////////
    protected    String    view    = null;
    protected    Model    model    = null;

    // Public Operations ///////////////////////////////////////////////////////
    /** Model accessor
     *
     *  Enables the retrieval of the model to be used by the view.
     *
     *  @return The model created from the result of the command execution.
     */
    public final Model getModel()
    {
        return model;
    }
    /** View accessor
     *
     *  Enables the retrieval of the view that shoudl be displayed.
     *
     *  @return The view to be displayed based upon the result of the command execution.
     */
    public final String getView()
    {
        return this.view;
    }
}
